Flutter推流SDK支持的接口_音视频终端 SDK(Apsara Video SDK)-阿里云帮助中心

本文为您介绍Flutter推流SDK相关的接口详情。

背景信息

更多关于接口的信息，请参见LIBRARIES。

基础类

类	dart	说明
AlivcLiveBase	live_base.dart	推流基础接口。
AlivcLivePusherConfig	live_push_config.dart	推流配置接口。
AlivcLivePusher	live_pusher.dart	推流引擎配置接口。
AlivcPusherPreview	live_pusher_preview.dart	推流预览视图控件。
-	live_push_def.dart	推流参数定义类。

推流基础接口

AlivcLiveBase

API	说明
init	创建AlivcLiveBase实例。
getSdkVersion	获取SDK版本号。
setObserver	设置监听回调接口。
setLogLevel	设置Log级别。
setConsoleEnable	启用或禁用控制台日志打印。
setLogPath	设置Log路径。
registerSDK	注册SDK。
setOnLicenceCheck	SDK Licence校验接口回调。监听setObserver回调。

推流配置接口

AlivcLivePusherConfig

API	说明
init	创建AlivcLivePusherConfig实例。
setResolution	设置分辨率。
getResolution	获取分辨率。
setEnableAutoBitrate	设置码率自适应。
getEnableAutoBitrate	获取码率自适应。
setEnableAutoResolution	设置分辨率自适应。
getEnableAutoResolution	获取分辨率自适应。
setQualityMode	设置码率模式。
getQualityMode	获取码率模式。
setTargetVideoBitrate	设置目标视频编码码率。
getTargetVideoBitrate	获取目标视频编码码率。
setMinVideoBitrate	设置最小视频编码码率。
getMinVideoBitrate	获取最小视频编码码率。
setInitialVideoBitrate	设置初始视频编码码率。
getInitialVideoBitrate	获取初始视频编码码率。
setAudioBitrate	设置音频编码码率。
getAudioBitrate	获取音频编码码率。
setAudioSampleRate	设置音频采样率。
getAudioSampleRate	获取音频采样率。
setFps	设置视频采集帧率。
getFps	获取视频采集帧率。
setMinFps	设置最小视频采集帧率。
getMinFps	获取最小视频采集帧率。
setVideoEncodeGop	设置关键帧间隔。
getVideoEncodeGop	获取关键帧间隔。
setAudioEncoderProfile	设置音频编码格式。
getAudioEncoderProfile	获取音频编码格式。
setAudioChannel	设置声道数。
getAudioChannel	获取声道数。
setAudioOnly	设置是否纯音频推流。
getAudioOnly	获取是否纯音频推流。
setVideoOnly	设置是否纯视频推流。
getVideoOnly	获取是否纯视频推流。
setAudioEncoderMode	设置音频编码模式。
getAudioEncoderMode	获取音频编码模式。
setVideoEncoderMode	设置视频编码模式。
getVideoEncoderMode	获取视频编码模式。
setVideoHardEncoderCodec	设置视频硬编码方式。
getVideoHardEncoderCodec	获取视频硬编码方式。
setOpenBFrame	设置视频硬编模式下是否开启B帧。
getOpenBFrame	获取视频硬编模式下是否开启B帧。
setOrientation	设置推流方向。
getOrientation	获取推流方向。
setPreviewDisplayMode	设置预览显示模式。
getPreviewDisplayMode	获取预览显示模式。
setConnectRetryInterval	设置重连时长。
getConnectRetryInterval	获取重连时长。
setConnectRetryCount	设置重连次数。
getConnectRetryCount	获取重连次数。
setPushMirror	设置推流镜像。
getPushMirror	获取推流镜像。
setPreviewMirror	设置预览镜像。
getPreviewMirror	获取预览镜像。
setCameraType	设置摄像头类型。
getCameraType	获取摄像头类型。
setAutoFocus	设置自动聚焦。
getAutoFocus	获取自动聚焦。
setPauseImg	设置暂停推流图片。
setNetworkPoorImg	设置码率低图片。
setExternAudioFormat	设置外部自定义音频数据。
getExternAudioFormat	获取外部自定义音频数据。
setExternVideoFormat	设置外部自定义视频数据。
getExternVideoFormat	获取外部自定义视频数据。
setAudioScene	设置音频应用场景。
getAudioScene	获取音频应用场景。
setExternMainStream	是否外部自定义数据推流。
getExternMainStream	获取是否外部自定义数据推流。

推流引擎配置接口

AlivcLivePusher

API	说明
init	创建AlivcLivePusher实例。
createConfig	创建Config，将AlivcLivePusherConfig和AlivcLivePusher联系起来。
initLivePusher	创建一个推流引擎实例。
setErrorDelegate	设置推流错误监听回调。
setInfoDelegate	设置推流状态监听回调。
setNetworkDelegate	设置推流网络监听回调。
setBGMDelegate	设置背景音乐监听回调。
startPreview	开始预览，同步接口。
startPreviewAsync	开始预览，异步接口。
startPushWithURL	开始推流，同步接口。
startPushWithURLAsync	开始推流，异步接口。
stopPreview	停止预览。
stopPush	停止推流。
restartPush	重新推流，同步接口。
restartPushAsync	重新推流，异步接口。
pause	暂停摄像头推流。
resume	恢复摄像头推流，同步接口。
resumeAsync	恢复推流，异步接口。
switchCamera	切换摄像头。
reconnectPushAsync	重连，异步接口。
reconnectPushAsyncWithPushURL	推流URL的重连，异步接口。
destroy	销毁推流引擎。
destroyConfigForIOS	iOS系统下重置Config。iOS系统执行此方法，在不使用AlivcLivePusherConfig的时候，及时清理设置的Config属性方法。
setAutoFocus	设置自动对焦。
focusCameraAtAdjustedPoint	对焦。
setZoom	缩放。
getMaxZoom	获取支持的最大变焦值。
getCurrentZoom	获取当前变焦值。
setFlash	闪光灯开关。
setExposure	设置曝光度。
getCurrentExposure	获取当前曝光度。
getSupportedMinExposure	获取支持最小曝光度。
getSupportedMaxExposure	获取支持最大曝光度。
setPushMirror	推流镜像开关。
setPreviewMirror	预览镜像开关。
setMute	静音推流。
setQualityMode	设置推流模式。
setTargetVideoBitrate	设置目标码率。
setMinVideoBitrate	设置最小码率。
setPreviewDisplayMode	设置预览显示模式。
setResolution	设置推流分辨率。只在预览模式下生效，推流中不能设置。
startBGMWithMusicPathAsync	播放背景音乐。
stopBGMAsync	停止播放背景音乐。
pauseBGM	暂停播放背景音乐。
resumeBGM	恢复播放背景音乐。
setBGMLoop	设置背景音乐是否循环播放。
setBGMEarsBack	设置背景音乐耳返开关。
setAudioDenoise	设置降噪开关。
setAudioEffectVoiceChangeMode	设置变声音效模式。
setAudioEffectReverbMode	设置混响音效模式。
setBGMVolume	设置背景音乐混音，音乐音量。
setCaptureVolume	设置背景音乐混音，人声音量。
sendMessage	设置自定义Message（SEI）。
isPushing	获取是否正在推流。
getPushURL	获取当前推流URL。
getLiveStatus	获取当前推流状态。
addWatermark	添加水印。
setWatermarkVisible	设置水印显示和隐藏。
addDynamicWaterMarkImageData	添加动态贴纸。
removeDynamicWaterMark	删除动态贴纸。
snapshot	截图。
setSnapshotDelegate	设置截图监听回调，需要在调用snapshot后调用。
sendVideoData	发送自定义视频数据。
sendPCMData	发送自定义音频数据。
setOnSDKError	SDK错误回调，监听setErrorDelegate回调。
setOnSystemError	系统错误回调，监听setErrorDelegate回调。
setOnPreviewStarted	开始预览回调，监听setInfoDelegate回调。
setOnPreviewStoped	停止预览回调，监听setInfoDelegate回调。
setOnFirstFramePreviewed	渲染第一帧回调，监听setInfoDelegate回调。
setOnPushStarted	推流开始回调，监听setInfoDelegate回调。
setOnPushPaused	摄像头推流暂停回调。监听setInfoDelegate回调。
setOnPushResumed	摄像头推流恢复回调，监听setInfoDelegate回调。
setOnPushRestart	重新推流回调，监听setInfoDelegate回调。
setOnPushStoped	推流停止回调，监听setInfoDelegate回调。
setOnConnectFail	推流链接失败，监听setNetworkDelegate回调。
setOnConnectRecovery	网络恢复，监听setNetworkDelegate回调。
setOnConnectionLost	连接被断开，监听setNetworkDelegate回调。
setOnNetworkPoor	网络差回调，监听setNetworkDelegate回调。
setOnReconnectError	重连失败回调，监听setNetworkDelegate回调。
setOnReconnectStart	重连开始回调，监听setNetworkDelegate回调。
setOnReconnectSuccess	重连成功回调，监听setNetworkDelegate回调。
setOnSendDataTimeout	发送数据超时，监听setNetworkDelegate回调。
setOnSendSeiMessage	发送SEI Message 通知，监听setNetworkDelegate回调。
setOnBGMCompleted	背景音乐播放完毕，监听setBGMDelegate回调。
setOnBGMDownloadTimeout	背景音乐下载播放超时，监听setBGMDelegate回调。
setOnBGMOpenFailed	背景音乐开启失败，监听setBGMDelegate回调。
setOnBGMPaused	背景音乐暂停播放，监听setBGMDelegate回调。
setOnBGMProgress	背景音乐当前播放进度，监听setBGMDelegate回调。
setOnBGMResumed	背景音乐恢复播放，监听setBGMDelegate回调。
setOnBGMStarted	背景音乐开始播放，监听setBGMDelegate回调。
setOnBGMStoped	背景音乐停止播放，监听setBGMDelegate回调。
setOnSnapshot	截图回调，监听setSnapshotDelegate回调。